Skip to main content
POST
/
public
/
v1
/
offsite-ads
/
audiences
/
user-list
[BETA] Create offsite user list audience job.
curl --request POST \
  --url https://api.topsort.com/public/v1/offsite-ads/audiences/user-list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My user list audience",
  "description": "This is a user list audience description."
}'
{
  "jobId": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://offsite-ads-user-list-uploads.s3.us-east-2.amazonaws.com/123e4567-e89b-12d3-a456-426614174000.csv"
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
vendor_id
string
required

The ID of the vendor to create the audience job for.

Examples:

"vendor_123"

​
dsp
enum<string>
required

The DSP to create the audience job for.

Available options:
google_ads,
meta

Body

application/json
​
name
string
required

The name of the user list audience.

Required string length: 1 - 64
Examples:

"My user list audience"

​
description
string | null

The description of the user list audience.

Required string length: 1 - 400
Examples:

"This is a user list audience description."

Response

Successful Response

​
jobId
string<uuid>
required

The unique identifier for the queued job.

Examples:

"123e4567-e89b-12d3-a456-426614174000"

​
url
string
required

The presigned url to upload the audience csv file. Presigned url must be used with PUT method and include the header Content-Type: text/csv.

Examples:

"https://offsite-ads-user-list-uploads.s3.us-east-2.amazonaws.com/123e4567-e89b-12d3-a456-426614174000.csv"